<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>websocket::stream::accept (1 of 6 overloads)</title>
<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="../../../../index.html" title="Chapter&#160;1.&#160;Boost.Beast">
<link rel="up" href="../accept.html" title="websocket::stream::accept">
<link rel="prev" href="../accept.html" title="websocket::stream::accept">
<link rel="next" href="overload2.html" title="websocket::stream::accept (2 of 6 overloads)">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td>
<td align="center"><a href="../../../../../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../accept.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../accept.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h6 class="title">
<a name="beast.ref.boost__beast__websocket__stream.accept.overload1"></a><a class="link" href="overload1.html" title="websocket::stream::accept (1 of 6 overloads)">websocket::stream::accept
          (1 of 6 overloads)</a>
</h6></div></div></div>
<p>
            Read and respond to a WebSocket HTTP Upgrade request.
          </p>
<h7><a name="beast.ref.boost__beast__websocket__stream.accept.overload1.h0"></a>
            <span class="phrase"><a name="beast.ref.boost__beast__websocket__stream.accept.overload1.synopsis"></a></span><a class="link" href="overload1.html#beast.ref.boost__beast__websocket__stream.accept.overload1.synopsis">Synopsis</a>
          </h7><pre class="programlisting"><span class="keyword">void</span>
<span class="identifier">accept</span><span class="special">();</span>
</pre>
<h7><a name="beast.ref.boost__beast__websocket__stream.accept.overload1.h1"></a>
            <span class="phrase"><a name="beast.ref.boost__beast__websocket__stream.accept.overload1.description"></a></span><a class="link" href="overload1.html#beast.ref.boost__beast__websocket__stream.accept.overload1.description">Description</a>
          </h7><p>
            This function is used to synchronously read an HTTP WebSocket Upgrade
            request and send the HTTP response. The call blocks until one of the
            following conditions is true:
          </p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem">
                The request is received and the response finishes sending.
              </li>
<li class="listitem">
                An error occurs on the stream.
              </li>
</ul></div>
<p>
            This function is implemented in terms of one or more calls to the next
            layer's <code class="computeroutput"><span class="identifier">read_some</span></code> and
            <code class="computeroutput"><span class="identifier">write_some</span></code> functions.
          </p>
<p>
            If the stream receives a valid HTTP WebSocket Upgrade request, an HTTP
            response is sent back indicating a successful upgrade. When this call
            returns, the stream is then ready to send and receive WebSocket protocol
            frames and messages. If the HTTP Upgrade request is invalid or cannot
            be satisfied, an HTTP response is sent indicating the reason and status
            code (typically 400, "Bad Request"). This counts as a failure.
          </p>
<p>
            The implementation uses fixed size internal storage to receive the request.
            If the request is too large, the error <a class="link" href="../../boost__beast__websocket__error.html" title="websocket::error"><code class="computeroutput"><span class="identifier">websocket</span><span class="special">::</span><span class="identifier">buffer_overflow</span></code></a> will be indicated.
            Applications that wish to receive larger requests should first read the
            request using their own buffer and a suitable overload of <a class="link" href="../../boost__beast__http__read.html" title="http::read"><code class="computeroutput"><span class="identifier">http</span><span class="special">::</span><span class="identifier">read</span></code></a> or <a class="link" href="../../boost__beast__http__async_read.html" title="http::async_read"><code class="computeroutput"><span class="identifier">http</span><span class="special">::</span><span class="identifier">async_read</span></code></a>, then call <a class="link" href="../accept.html" title="websocket::stream::accept"><code class="computeroutput"><span class="identifier">websocket</span><span class="special">::</span><span class="identifier">stream</span><span class="special">::</span><span class="identifier">accept</span></code></a> or <a class="link" href="../async_accept.html" title="websocket::stream::async_accept"><code class="computeroutput"><span class="identifier">websocket</span><span class="special">::</span><span class="identifier">stream</span><span class="special">::</span><span class="identifier">async_accept</span></code></a> with the request.
          </p>
<h7><a name="beast.ref.boost__beast__websocket__stream.accept.overload1.h2"></a>
            <span class="phrase"><a name="beast.ref.boost__beast__websocket__stream.accept.overload1.exceptions"></a></span><a class="link" href="overload1.html#beast.ref.boost__beast__websocket__stream.accept.overload1.exceptions">Exceptions</a>
          </h7><div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
                    <p>
                      Type
                    </p>
                  </th>
<th>
                    <p>
                      Thrown On
                    </p>
                  </th>
</tr></thead>
<tbody><tr>
<td>
                    <p>
                      <code class="computeroutput"><span class="identifier">system_error</span></code>
                    </p>
                  </td>
<td>
                    <p>
                      Thrown on failure.
                    </p>
                  </td>
</tr></tbody>
</table></div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright &#169; 2016, 2017 Vinnie Falco<p>
        Distributed under the Boost Software License, Version 1.0. (See accompanying
        file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
      </p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../accept.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../accept.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>
